<?xml version="1.0" encoding="utf-8" ?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<meta name="generator" content="Docutils 0.4: http://docutils.sourceforge.net/" />
<title>PySpec ユーザガイド</title>
<meta name="author" content="Shibukawa Yoshiki" />
<meta name="copyright" content="This document has been placed in the public domain." />
<style type="text/css">

/*
:Author: David Goodger
:Contact: goodger@users.sourceforge.net
:Date: $Date: 2005-12-18 01:56:14 +0100 (Sun, 18 Dec 2005) $
:Revision: $Revision: 4224 $
:Copyright: This stylesheet has been placed in the public domain.

Default cascading style sheet for the HTML output of Docutils.

See http://docutils.sf.net/docs/howto/html-stylesheets.html for how to
customize this style sheet.
*/

/* used to remove borders from tables and images */
.borderless, table.borderless td, table.borderless th {
  border: 0 }

table.borderless td, table.borderless th {
  /* Override padding for "table.docutils td" with "! important".
     The right padding separates the table cells. */
  padding: 0 0.5em 0 0 ! important }

.first {
  /* Override more specific margin styles with "! important". */
  margin-top: 0 ! important }

.last, .with-subtitle {
  margin-bottom: 0 ! important }

.hidden {
  display: none }

a.toc-backref {
  text-decoration: none ;
  color: black }

blockquote.epigraph {
  margin: 2em 5em ; }

dl.docutils dd {
  margin-bottom: 0.5em }

/* Uncomment (and remove this text!) to get bold-faced definition list terms
dl.docutils dt {
  font-weight: bold }
*/

div.abstract {
  margin: 2em 5em }

div.abstract p.topic-title {
  font-weight: bold ;
  text-align: center }

div.admonition, div.attention, div.caution, div.danger, div.error,
div.hint, div.important, div.note, div.tip, div.warning {
  margin: 2em ;
  border: medium outset ;
  padding: 1em }

div.admonition p.admonition-title, div.hint p.admonition-title,
div.important p.admonition-title, div.note p.admonition-title,
div.tip p.admonition-title {
  font-weight: bold ;
  font-family: sans-serif }

div.attention p.admonition-title, div.caution p.admonition-title,
div.danger p.admonition-title, div.error p.admonition-title,
div.warning p.admonition-title {
  color: red ;
  font-weight: bold ;
  font-family: sans-serif }

/* Uncomment (and remove this text!) to get reduced vertical space in
   compound paragraphs.
div.compound .compound-first, div.compound .compound-middle {
  margin-bottom: 0.5em }

div.compound .compound-last, div.compound .compound-middle {
  margin-top: 0.5em }
*/

div.dedication {
  margin: 2em 5em ;
  text-align: center ;
  font-style: italic }

div.dedication p.topic-title {
  font-weight: bold ;
  font-style: normal }

div.figure {
  margin-left: 2em ;
  margin-right: 2em }

div.footer, div.header {
  clear: both;
  font-size: smaller }

div.line-block {
  display: block ;
  margin-top: 1em ;
  margin-bottom: 1em }

div.line-block div.line-block {
  margin-top: 0 ;
  margin-bottom: 0 ;
  margin-left: 1.5em }

div.sidebar {
  margin-left: 1em ;
  border: medium outset ;
  padding: 1em ;
  background-color: #ffffee ;
  width: 40% ;
  float: right ;
  clear: right }

div.sidebar p.rubric {
  font-family: sans-serif ;
  font-size: medium }

div.system-messages {
  margin: 5em }

div.system-messages h1 {
  color: red }

div.system-message {
  border: medium outset ;
  padding: 1em }

div.system-message p.system-message-title {
  color: red ;
  font-weight: bold }

div.topic {
  margin: 2em }

h1.section-subtitle, h2.section-subtitle, h3.section-subtitle,
h4.section-subtitle, h5.section-subtitle, h6.section-subtitle {
  margin-top: 0.4em }

h1.title {
  text-align: center }

h2.subtitle {
  text-align: center }

hr.docutils {
  width: 75% }

img.align-left {
  clear: left }

img.align-right {
  clear: right }

ol.simple, ul.simple {
  margin-bottom: 1em }

ol.arabic {
  list-style: decimal }

ol.loweralpha {
  list-style: lower-alpha }

ol.upperalpha {
  list-style: upper-alpha }

ol.lowerroman {
  list-style: lower-roman }

ol.upperroman {
  list-style: upper-roman }

p.attribution {
  text-align: right ;
  margin-left: 50% }

p.caption {
  font-style: italic }

p.credits {
  font-style: italic ;
  font-size: smaller }

p.label {
  white-space: nowrap }

p.rubric {
  font-weight: bold ;
  font-size: larger ;
  color: maroon ;
  text-align: center }

p.sidebar-title {
  font-family: sans-serif ;
  font-weight: bold ;
  font-size: larger }

p.sidebar-subtitle {
  font-family: sans-serif ;
  font-weight: bold }

p.topic-title {
  font-weight: bold }

pre.address {
  margin-bottom: 0 ;
  margin-top: 0 ;
  font-family: serif ;
  font-size: 100% }

pre.literal-block, pre.doctest-block {
  margin-left: 2em ;
  margin-right: 2em ;
  background-color: #eeeeee }

span.classifier {
  font-family: sans-serif ;
  font-style: oblique }

span.classifier-delimiter {
  font-family: sans-serif ;
  font-weight: bold }

span.interpreted {
  font-family: sans-serif }

span.option {
  white-space: nowrap }

span.pre {
  white-space: pre }

span.problematic {
  color: red }

span.section-subtitle {
  /* font-size relative to parent (h1..h6 element) */
  font-size: 80% }

table.citation {
  border-left: solid 1px gray;
  margin-left: 1px }

table.docinfo {
  margin: 2em 4em }

table.docutils {
  margin-top: 0.5em ;
  margin-bottom: 0.5em }

table.footnote {
  border-left: solid 1px black;
  margin-left: 1px }

table.docutils td, table.docutils th,
table.docinfo td, table.docinfo th {
  padding-left: 0.5em ;
  padding-right: 0.5em ;
  vertical-align: top }

table.docutils th.field-name, table.docinfo th.docinfo-name {
  font-weight: bold ;
  text-align: left ;
  white-space: nowrap ;
  padding-left: 0 }

h1 tt.docutils, h2 tt.docutils, h3 tt.docutils,
h4 tt.docutils, h5 tt.docutils, h6 tt.docutils {
  font-size: 100% }

tt.docutils {
  background-color: #eeeeee }

ul.auto-toc {
  list-style-type: none }

</style>
</head>
<body>
<div class="document" id="pyspec">
<h1 class="title">PySpec ユーザガイド</h1>
<table class="docinfo" frame="void" rules="none">
<col class="docinfo-name" />
<col class="docinfo-content" />
<tbody valign="top">
<tr><th class="docinfo-name">Author:</th>
<td>Shibukawa Yoshiki</td></tr>
<tr><th class="docinfo-name">Contact:</th>
<td>yoshiki at shibu.jp</td></tr>
<tr><th class="docinfo-name">Copyright:</th>
<td>This document has been placed in the public domain.</td></tr>
</tbody>
</table>
<div class="contents topic">
<p class="topic-title first"><a id="contents" name="contents">Contents</a></p>
<ul class="simple">
<li><a class="reference" href="#id1" id="id6" name="id6">仕様の書き方/実行の仕方</a><ul>
<li><a class="reference" href="#id2" id="id7" name="id7">仕様を書く</a></li>
<li><a class="reference" href="#id3" id="id8" name="id8">コンソールでの仕様の実行</a></li>
<li><a class="reference" href="#gui" id="id9" name="id9">GUIでの仕様の実行</a></li>
</ul>
</li>
<li><a class="reference" href="#id4" id="id10" name="id10">仕様名称</a><ul>
<li><a class="reference" href="#id5" id="id11" name="id11">メソッド名</a></li>
<li><a class="reference" href="#docstring" id="id12" name="id12">Docstring</a></li>
</ul>
</li>
</ul>
</div>
<div class="section">
<h1><a class="toc-backref" href="#id6" id="id1" name="id1">仕様の書き方/実行の仕方</a></h1>
<div class="section">
<h2><a class="toc-backref" href="#id7" id="id2" name="id2">仕様を書く</a></h2>
<p>PySpecでは、Pythonの関数、もしくはメソッドを使って仕様を表現します。
仕様メソッドであるという宣言を行うデコレータを付加することで、仕様メソッド
として扱われるようになります。</p>
<p>example:</p>
<pre class="literal-block">
# これは関数形式の仕様

&#64;spec
def New_list_should_be_empty():
    About(list()).should_be_empty()

# これがメソッド形式の仕様
class List_Behavior(object):
  &#64;spec
  def New_list_should_be_empty():
      About(list()).should_be_empty()
</pre>
<p>もし、仕様メソッドと、コンテキスト(コンテキストは準備を行うメソッド)の間で、
何かデータやオブジェクトを共有したい場合には、仕様はクラスにまとめる方が良いです。
PySpecはお互いのメソッド間で悪影響が起きないように独立した環境を作成します。
仕様メソッドごとにクラスのオブジェクトを生成してから実行します。クラスにまとめると
他の領域を侵すことがなくなります。</p>
<p>PySpecはモジュールのトップレベルの関数もしくはクラスを調査してテストを発見します。
もし、ネストされたクラスの中に仕様を記述した場合には、その仕様は実行されません。</p>
</div>
<div class="section">
<h2><a class="toc-backref" href="#id8" id="id3" name="id3">コンソールでの仕様の実行</a></h2>
<p>コンソールでの実行の仕方には二通りあります。ひとつが <tt class="docutils literal"><span class="pre">cuipyspec.py</span></tt> スクリプトを
実行することです。もうひとつの方法は、スタートアップコードを、仕様のソースコードに
追加することです。後者の方が簡単です。</p>
<dl class="docutils">
<dt>example::</dt>
<dd><p class="first">from pyspec import *</p>
<p># ここに仕様を定義していきます。</p>
<dl class="last docutils">
<dt>if __name__ == &quot;__main__&quot;:</dt>
<dd>run_test()</dd>
</dl>
</dd>
</dl>
<p>仕様を登録するコードを書く必要はありません。PySpecはロードされているすべての
モジュールを自動的に調べます。このため、上記のコードでもテストが実行されます。</p>
<p>もし、いくつかのファイルに分かれた仕様をまとめて実行したい場合には、以下のような
テスト起動用のスクリプトを作成するのが一番簡単な方法です。</p>
<dl class="docutils">
<dt>example::</dt>
<dd><p class="first">from pyspec import*</p>
<p>import behavior_entities
import behavior_database_access
import behavior_views</p>
<p class="last">run_test()</p>
</dd>
</dl>
<p>このようなスタートアップスクリプトを作成すると同時に、すべての仕様スクリプトに
個別実行用のスタートアップコードを書いておくと、まとめて実行したり、
個別にも実行したりできるため便利です。</p>
</div>
<div class="section">
<h2><a class="toc-backref" href="#id9" id="gui" name="gui">GUIでの仕様の実行</a></h2>
<p>GUI上でも実行することができます。 <tt class="docutils literal"><span class="pre">wxpyspec.py</span></tt> スクリプトを実行してください。
<tt class="docutils literal"><span class="pre">[Project]</span> <span class="pre">-</span> <span class="pre">[Add</span> <span class="pre">module...]</span></tt> メニューを使い、仕様のモジュールを追加することが
できます。</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field"><th class="field-name">注意:</th><td class="field-body">現在GUIランナーは開発途中です。いくつかのバグや修正すべき箇所が残っています。</td>
</tr>
</tbody>
</table>
<p>もしGUIのスタートアップコードを仕様スクリプトに追加したい場合には、
以下のようなコードを追加します:</p>
<pre class="literal-block">
if __name__ == &quot;__main__&quot;:
    import pyspec.wxui.controller
    controller = pyspec.wxui.controller.WxPySpecController(0)
    controller.MainLoop()
</pre>
</div>
</div>
<div class="section">
<h1><a class="toc-backref" href="#id10" id="id4" name="id4">仕様名称</a></h1>
<p>良い仕様を書くためには、良い名前を付ける必要があります。 PySpecでは、この名前を付けるのに
二通りの方法があります。これらの仕様名は結果レポートの中に書き込まれます。</p>
<div class="section">
<h2><a class="toc-backref" href="#id11" id="id5" name="id5">メソッド名</a></h2>
<p>メソッド名を使用する書き方がシンプルな方法です。</p>
<table border="1" class="docutils">
<colgroup>
<col width="53%" />
<col width="47%" />
</colgroup>
<thead valign="bottom">
<tr><th class="head">メソッド名</th>
<th class="head">仕様名</th>
</tr>
</thead>
<tbody valign="top">
<tr><td><tt class="docutils literal"><span class="pre">A_stack_which_have_one_value()</span></tt></td>
<td><tt class="docutils literal"><span class="pre">A</span> <span class="pre">stack</span> <span class="pre">which</span> <span class="pre">have</span> <span class="pre">one</span> <span class="pre">value</span></tt></td>
</tr>
<tr><td><tt class="docutils literal"><span class="pre">version_info__in_sys_module()</span></tt></td>
<td><tt class="docutils literal"><span class="pre">version_info</span> <span class="pre">in</span> <span class="pre">sys</span> <span class="pre">module</span></tt></td>
</tr>
<tr><td><tt class="docutils literal"><span class="pre">one_of__test_method__should_fail()</span></tt></td>
<td><tt class="docutils literal"><span class="pre">one</span> <span class="pre">of</span> <span class="pre">test_method</span> <span class="pre">should</span> <span class="pre">fail</span></tt></td>
</tr>
</tbody>
</table>
<p>この機能は <tt class="docutils literal"><span class="pre">pyspec.util.create_spec_name()</span></tt> で実装されています。</p>
</div>
<div class="section">
<h2><a class="toc-backref" href="#id12" id="docstring" name="docstring">Docstring</a></h2>
<p>Docstringも仕様名として使用されます。Python 2.Xはメソッド名としてはアスキー英数字のみ
が使用できます。この機能はアジア圏のプログラマが自分の言語を使いたい場合に使用できます。</p>
<p>もしコンテキストメソッドおよび、仕様メソッドにdocstringを書いたとすると、最初の行が
仕様名として使用されます。</p>
<p>PySpecはソースコードの最初の行から文字コードを取得します。もし日本語や中国語などの
言語を使用したい場合には以下のように書きます:</p>
<pre class="literal-block">
# -*- coding: utf8 -*-
</pre>
<p>PySpecはPythonで扱えるコーデックならば扱うことができます。</p>
<p>example:</p>
<pre class="literal-block">
class StackBehavior(object):
    &quot;&quot;&quot;スタックの動作仕様.&quot;&quot;&quot;
    &#64;context
    def A_stack_with_one_item(self):
        &quot;&quot;&quot;要素をひとつ持つスタック.&quot;&quot;&quot;
        self.stack = Stack()
        self.stack.push(&quot;one item&quot;)

    &#64;spec
    def should_not_be_empty(self):
        &quot;&quot;&quot;空ではない.&quot;&quot;&quot;
        About(self.stack).should_not_be_empty()
</pre>
<p>result:</p>
<pre class="literal-block">
要素をひとつ持つスタック
    空ではない ... OK
</pre>
</div>
</div>
</div>
</body>
</html>
